home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.n / message.n < prev    next >
Text File  |  1995-07-25  |  11KB  |  198 lines
  1.  
  2.  
  3.  
  4.      mmmmeeeessssssssaaaaggggeeee((((nnnn))))                   TTTTkkkk (((( ))))                    mmmmeeeessssssssaaaaggggeeee((((nnnn))))
  5.  
  6.  
  7.  
  8.      _________________________________________________________________
  9.  
  10.      NNNNAAAAMMMMEEEE
  11.           message - Create and manipulate message widgets
  12.  
  13.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.           mmmmeeeessssssssaaaaggggeeee _p_a_t_h_N_a_m_e ?_o_p_t_i_o_n_s?
  15.  
  16.      SSSSTTTTAAAANNNNDDDDAAAARRRRDDDD OOOOPPPPTTTTIIIIOOOONNNNSSSS
  17.           aaaannnncccchhhhoooorrrr          ccccuuuurrrrssssoooorrrr         ppppaaaaddddXXXX            tttteeeexxxxtttt           |
  18.           bbbbaaaacccckkkkggggrrrroooouuuunnnndddd      ffffoooonnnntttt           ppppaaaaddddYYYY            tttteeeexxxxttttVVVVaaaarrrriiiiaaaabbbblllleeee   |
  19.           bbbboooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh     ffffoooorrrreeeeggggrrrroooouuuunnnndddd     rrrreeeelllliiiieeeeffff          wwwwiiiiddddtttthhhh          |
  20.  
  21.           See the ``options'' manual entry for details on the standard
  22.           options.
  23.  
  24.      WWWWIIIIDDDDGGGGEEEETTTT----SSSSPPPPEEEECCCCIIIIFFFFIIIICCCC OOOOPPPPTTTTIIIIOOOONNNNSSSS
  25.           Name:           aaaassssppppeeeecccctttt
  26.           Class:          AAAAssssppppeeeecccctttt
  27.           Command-Line Switch:----aaaassssppppeeeecccctttt
  28.  
  29.                Specifies  a  non-negative  integer  value   indicating
  30.                desired aspect ratio for the text.  The aspect ratio is
  31.                specified as  100*width/height.   100  means  the  text
  32.                should  be  as  wide  as it is tall, 200 means the text
  33.                should be twice as wide as it is  tall,  50  means  the
  34.                text  should be twice as tall as it is wide, and so on.  |
  35.                Used to choose line length for  text  if  wwwwiiiiddddtttthhhh  option  |
  36.                isn't specified.  Defaults to 150.
  37.  
  38.           Name:           jjjjuuuussssttttiiiiffffyyyy
  39.           Class:          JJJJuuuussssttttiiiiffffyyyy
  40.           Command-Line Switch:----jjjjuuuussssttttiiiiffffyyyy
  41.  
  42.                Specifies how to justify lines of text.  Must be one of
  43.                lllleeeefffftttt, cccceeeennnntttteeeerrrr, or rrrriiiigggghhhhtttt.  Defaults to lllleeeefffftttt.  This option  |
  44.                works together with the aaaannnncccchhhhoooorrrr, aaaassssppppeeeecccctttt, ppppaaaaddddXXXX, ppppaaaaddddYYYY, and  |
  45.                wwwwiiiiddddtttthhhh  options  to provide a variety of arrangements of  |
  46.                the text within  the  window.   The  aaaassssppppeeeecccctttt  and  wwwwiiiiddddtttthhhh  |
  47.                options  determine the amount of screen space needed to  |
  48.                display the text.  The aaaannnncccchhhhoooorrrr, ppppaaaaddddXXXX, and  ppppaaaaddddYYYY  options  |
  49.                determine  where  this  rectangular  area  is displayed  |
  50.                within the widget's  window,  and  the  jjjjuuuussssttttiiiiffffyyyy  option  |
  51.                determines  how  each  line  is  displayed  within that  |
  52.                rectangular region.  For example, suppose aaaannnncccchhhhoooorrrr  is  eeee  |
  53.                and  jjjjuuuussssttttiiiiffffyyyy  is  lllleeeefffftttt,  and that the message window is  |
  54.                much larger than needed for the  text.   The  the  text  |
  55.                will  displayed so that the left edges of all the lines  |
  56.                line up and the right edge of the longest line is  ppppaaaaddddXXXX  |
  57.                from  the  right  side  of the window;  the entire text  |
  58.                block will be centered in  the  vertical  span  of  the  |
  59.                window.
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 7/23/95)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      mmmmeeeessssssssaaaaggggeeee((((nnnn))))                   TTTTkkkk (((( ))))                    mmmmeeeessssssssaaaaggggeeee((((nnnn))))
  71.  
  72.  
  73.  
  74.           Name:           wwwwiiiiddddtttthhhh                                         |
  75.           Class:          WWWWiiiiddddtttthhhh                                         |
  76.           Command-Line Switch:----wwwwiiiiddddtttthhhh                                    |
  77.  
  78.                                                                              ||
  79.                Specifies the length of lines in the window.  The value  |
  80.                may have any of the forms acceptable  to  TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss.  |
  81.                If  this  option has a value greater than zero then the  |
  82.                aaaassssppppeeeecccctttt  option  is  ignored  and   the   wwwwiiiiddddtttthhhh   option  |
  83.                determines the line length.  If this option has a value  |
  84.                less than or equal to  zero,  then  the  aaaassssppppeeeecccctttt  option  |
  85.                determines the line length.
  86.      _________________________________________________________________
  87.  
  88.  
  89.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  90.           The mmmmeeeessssssssaaaaggggeeee command creates  a  new  window  (given  by  the
  91.           _p_a_t_h_N_a_m_e  argument)  and  makes  it  into  a message widget.
  92.           Additional options, described above, may be specified on the
  93.           command  line or in the option database to configure aspects
  94.           of the message such as its colors, font, text,  and  initial
  95.           relief.   The mmmmeeeessssssssaaaaggggeeee command returns its _p_a_t_h_N_a_m_e argument.
  96.           At the time this command is invoked, there must not exist  a
  97.           window named _p_a_t_h_N_a_m_e, but _p_a_t_h_N_a_m_e's parent must exist.
  98.  
  99.           A message is a widget that displays  a  textual  string.   A
  100.           message widget has three special features.  First, it breaks
  101.           up its string into lines in order to produce a given  aspect
  102.           ratio  for  the  window.  The line breaks are chosen at word
  103.           boundaries wherever possible (if  not  even  a  single  word
  104.           would  fit  on  a  line,  then the word will be split across
  105.           lines).  Newline characters in the string  will  force  line
  106.           breaks;  they can be used, for example, to leave blank lines
  107.           in the display.
  108.  
  109.           The second feature of a  message  widget  is  justification.
  110.           The  text  may be displayed left-justified (each line starts
  111.           at the left side of the window), centered on a  line-by-line
  112.           basis,  or right-justified (each line ends at the right side
  113.           of the window).
  114.  
  115.           The third feature of a message widget  is  that  it  handles
  116.           control  characters  and  non-printing characters specially.
  117.           Tab characters are replaced with enough blank space to  line
  118.           up  on  the  next 8-character boundary.  Newlines cause line
  119.           breaks.  Other control  characters  (ASCII  code  less  than
  120.           0x20)  and  characters not defined in the font are displayed
  121.           as a four-character sequence \\\\xxxx_h_h where _h_h is the  two-digit
  122.           hexadecimal  number  corresponding to the character.  In the
  123.           unusual case where the  font  doesn't  contain  all  of  the
  124.           characters in ``0123456789abcdef\x'' then control characters
  125.           and undefined characters are not displayed at all.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 7/23/95)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      mmmmeeeessssssssaaaaggggeeee((((nnnn))))                   TTTTkkkk (((( ))))                    mmmmeeeessssssssaaaaggggeeee((((nnnn))))
  137.  
  138.  
  139.  
  140.      WWWWIIIIDDDDGGGGEEEETTTT CCCCOOOOMMMMMMMMAAAANNNNDDDD
  141.           The mmmmeeeessssssssaaaaggggeeee command creates a new Tcl command whose name  is
  142.           _p_a_t_h_N_a_m_e.   This  command  may  be  used  to  invoke various
  143.           operations on the widget.   It  has  the  following  general
  144.           form:
  145.  
  146.                _p_a_t_h_N_a_m_e _o_p_t_i_o_n ?_a_r_g _a_r_g ...?
  147.           _O_p_t_i_o_n and the _a_r_gs determine  the  exact  behavior  of  the
  148.           command.   The  following  commands are possible for message
  149.           widgets:
  150.  
  151.           _p_a_t_h_N_a_m_e ccccoooonnnnffffiiiigggguuuurrrreeee ?_o_p_t_i_o_n? ?_v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...?
  152.                Query  or  modify  the  configuration  options  of  the
  153.                widget.   If  no  _o_p_t_i_o_n  is  specified, returns a list
  154.                describing all of the available  options  for  _p_a_t_h_N_a_m_e
  155.                (see  TTTTkkkk____CCCCoooonnnnffffiiiigggguuuurrrreeeeIIIInnnnffffoooo for information on the format of
  156.                this list).  If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then
  157.                the  command  returns  a  list describing the one named
  158.                option  (this   list   will   be   identical   to   the
  159.                corresponding  sublist  of  the  value  returned  if no
  160.                _o_p_t_i_o_n is specified).   If  one  or  more  _o_p_t_i_o_n-_v_a_l_u_e
  161.                pairs  are  specified,  then  the  command modifies the
  162.                given widget option(s) to have the given value(s);   in
  163.                this  case the command returns an empty string.  _O_p_t_i_o_n
  164.                may have any of the  values  accepted  by  the  mmmmeeeessssssssaaaaggggeeee
  165.                command.
  166.  
  167.  
  168.      DDDDEEEEFFFFAAAAUUUULLLLTTTT BBBBIIIINNNNDDDDIIIINNNNGGGGSSSS
  169.           When a new message is  created,  it  has  no  default  event
  170.           bindings: messages are intended for output purposes only.
  171.  
  172.  
  173.      BBBBUUUUGGGGSSSS
  174.           Tabs don't work very well with  text  that  is  centered  or
  175.           right-justified.  The most common result is that the line is
  176.           justified wrong.
  177.  
  178.  
  179.      KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS
  180.           message, widget
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  192.  
  193.  
  194.      Page 3                                          (printed 7/23/95)
  195.  
  196.  
  197.  
  198.